.. _Array Functions:

===============
Array Functions
===============

.. toctree::
   :maxdepth: 5
   :hidden:
   :glob:

   *

+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Function**                                            | **Description**                                                                                                                         |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_Create<Array_Create>`                       | Create a new array with a specified number of empty items.                                                                              |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_CreateEx<Array_CreateEx>`                   | Create a new array with a specified number of empty items of a specified size (in bytes) of each item.                                  |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_Destroy<Array_Destroy>`                     | Deallocates and frees all array items and the array itself.                                                                             |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_Extend<Array_Extend>`                       | Extend (grow) an array and add new empty items.                                                                                         |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemAddress<Array_ItemAddress>`             | Get the address of an array item specified by the item index.                                                                           |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemLength<Array_ItemLength>`               | Get the stored length of an array item.                                                                                                 |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemsAddValue<Array_ItemsAddValue>`         | Add an integer value for every item of a QWORD array.                                                                                   |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemSetData<Array_ItemSetData>`             | Write byte data of a specified length to an array item.                                                                                 |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemSetText<Array_ItemSetText>`             | Write a zero terminated text string to an array item.                                                                                   |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemsMulValue<Array_ItemsMulValue>`         | Multiply an integer value for every item of a QWORD array.                                                                              |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_ItemsSubValue<Array_ItemsSubValue>`         | Subtract an integer value for every item of a QWORD array.                                                                              |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_LoadItemsFromFile<Array_LoadItemsFromFile>` | Create an array by loading a text file. Each line of the text file is set as a new item in the array.                                   |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_LoadItemsFromMem<Array_LoadItemsFromMem>`   | Create an array by loading items array from memory. Each line of the text in memory is set as a new item in the array.                  |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_Resize<Array_Resize>`                       | Resize array (reallocate array memory) to a different item count.                                                                       |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_SaveItemsToFile<Array_SaveItemsToFile>`     | Saves all array items to a file.                                                                                                        |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_SaveItemsToMem<Array_SaveItemsToMem>`       | Write the array items, separated with a carriage return and line feed (CRLF), to a pre-allocated memory buffer.                         |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_TotalItems<Array_TotalItems>`               | Get the total count of all array items in an array.                                                                                     |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_TotalMemory<Array_TotalMemory>`             | Get the total amount of memory to store the whole array and its items.                                                                  |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array_Truncate<Array_Truncate>`                   | Truncate (shrink) an array and free any excess items.                                                                                   |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+